package cn.edu.zhku.swagger.notes;

public interface GroupApiNotes {

    String addGroup = "必须有群组名称 groupName，也可提供forbidden，默认是false，即表示可加入\n" +
            "{\n" +
            "  \"groupName\" : \"张老师_群组3\",\n" +
            "  \"forbidden\": false\n" +
            "}";

    String joinGroup = "提供邀请码inviteCode\n" +
            "{\n" +
            "  \"inviteCode\": \"\"\n" +
            "}";

    String editGroup = "必须有groupId，可提供groupName和forbidden，groupName不能为''\n" +
            "{\n" +
            "  \"groupId\" : 3,\n" +
            "  \"groupName\" : \"张老师_群组测试3\",\n" +
            "  \"forbidden\": false\n" +
            "}";

    String removeGroupBatch = "必须有 groupIds\n" +
            "{\n" +
            "  \"groupIds\": [\n" +
            "    1, 3\n" +
            "  ]\n" +
            "}";

    String removeGroup = "必须有 groupId\n" +
            "{\n" +
            "  \"groupId\": 2\n" +
            "}";

    String removeUserBatch = "必须有groupId，userIds\n" +
            "{\n" +
            "  \"groupId\": 1,\n" +
            "  \"userIds\": [\n" +
            "    4, 5\n" +
            "  ]\n" +
            "}";

    String removeUser = "必须有groupId，userId\n" +
            "{\n" +
            "  \"groupId\": 1,\n" +
            "  \"userId\": 3\n" +
            "}";

    String quit = "必须有groupId\n" +
            "{\n" +
            "  \"groupId\" : 3\n" +
            "}";

    String removeTaskBatch = "必须有groupId，taskIds\n" +
            "{\n" +
            "  \"groupId\": 1,\n" +
            "  \"taskIds\" : [\n" +
            "    4, 5\n" +
            "  ]\n" +
            "}";

    String removeTask = "必须有groupId，taskId\n" +
            "{\n" +
            "  \"groupId\": 1,\n" +
            "  \"taskId\" : 3\n" +
            "\n" +
            "}";

    String tea = "支持对groupName的模糊查询，也可提供forbidden筛选群组\n" +
            "{\n" +
            "  \"groupName\": \"_\",\n" +
            "  \"forbidden\": false,\n" +
            "  \"pageNum\": 0,\n" +
            "  \"pageSize\": 5,\n" +
            "}";

    String stu = "支持对groupName的模糊查询\n" +
            "{\n" +
            "  \"groupName\": \"\",\n" +
            "  \"pageNum\": 0,\n" +
            "  \"pageSize\": 5,\n" +
            "}";

    String groupUser = "必须有groupId，支持对用户的学号no和真实姓名realname的模糊查询\n" +
            "{\n" +
            "  \"groupId\": 2,\n" +
            "  \"no\" : \"\",\n" +
            "  \"realname\" : \"\",\n" +
            "  \"pageNum\": 0,\n" +
            "  \"pageSize\": 10,\n" +
            "}";

    String teaTask = "必须有groupId，" +
            "\n支持对标题title和地区area的模糊查询，可选择至创建时间createTime到过期时间expireTime来筛选任务\n" +
            "{\n" +
            "  \"groupId\" : 1,\n" +
            "  \"title\" : \"\",\n" +
            "  \"area\" : \"\",\n" +
            "  \"createTime\" : \"\",\n" +
            "  \"expireTime\" : \"\",\n" +
            "  \"pageNum\": 0,\n" +
            "  \"pageSize\": 5,\n" +
            "}";

    String stuTask = "必须有groupId，\n返回的任务要么是学生提交或保存过表单的，要么是自学生入群以来所能够参与的\n" +
            "同样支持对标题title和地区area的模糊查询，可选择至创建时间createTime到过期时间expireTime来筛选任务\n" +
            "{\n" +
            "  \"groupId\" : 2,\n" +
            "  \"title\" : \"\",\n" +
            "  \"area\" : \"\",\n" +
            "  \"createTime\" : \"\",\n" +
            "  \"expireTime\" : \"\",\n" +
            "  \"pageNum\": 0,\n" +
            "  \"pageSize\": 5,\n" +
            "}";
}
